Reader Expanders

Table Name: GXT_READEREXPANDERS_TBL

List

Request a list of reader expanders.

  • Request:

    Copy 
    http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=List&SubType=GXT_READEREXPANDERS_TBL

  • Response:

    Copy 
    0=Onboard Reader&1=Reader Expander 2

Detail

Request the details of a specific reader expander.

  • Request:

    Copy 
    http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Request&Type=Detail&SubType=GXT_READEREXPANDERS_TBL&RecId=<RecId>

  • Response:

    Copy 
    ReaderExpanderId=0&Name=Onboard Reader&PollTime=250&ReaderOneFormat=32&ReaderTwoFormat=32&ReaderOneLocation=1&ReaderTwoLocation=1&ReaderOneMode=0&ReaderTwoMode=0&ReaderOneDoor=0&ReaderTwoDoor=1&ReaderOneKeypadType=2&ReaderTwoKeypadType=2&KeypadToUseForPINsReader1=2147483647&KeypadToUseForPINsReader2=2147483647&ReaderOneArmingMode=0&ReaderTwoArmingMode=0&AllowReadingOpenedUnlocked=true&InputFunctionsEnabled=true&LED1FollowsLock1PGM=false&BondSenseInputEnabled=false&REXEnabled=true&RENEnabled=false&SendFormatErrors=true&IntelligentReaderTamperMode=false&AllowReadingOpenedUnlocked1=true&InputFunctionsEnabled1=true&LED1FollowsLock1PGM1=false&BondSenseInputEnabled1=false&REXEnabled1=true&RENEnabled1=false&SendFormatErrors1=true&IntelligentReaderTamperMode1=false&DisarmAreaForDoorOnAccess=false&AllowAccessWhenAreaArmed=false&DisarmUsersAreaONValidCard=false&LogReaderEvents=false&SwapLockLEDDisplay=false&ActivateAccessLevelPGM=false&DisplayCardDetailWhenInvalid=true&ArmUsersArea=false&DisarmAreaForDoorOnAccess1=false&AllowAccessWhenAreaArmed1=false&DisarmUsersAreaONValidCard1=false&LogReaderEvents1=false&SwapLockLEDDisplay1=false&ActivateAccessLevelPGM1=false&DisplayCardDetailWhenInvalid1=true&ArmUsersArea1=false&HighChargeOption=false&MultipleReaderInputPort1=false&MultipleReaderInputPort2=false&VirtualModule=false&InvertDeviceTamper=false&EthernetSALLISEnabled=false&EthernetSALLISPort=1234&EthernetSALLISIp=192.168.0.234&Reader1AreaControlArea=2147483647&Reader2AreaControlArea=2147483647&EnableBeamFunctionOnZone3=false&InvertDoorStateControlR1=false&InvertSenseStateControlR1=false&InvertREXInputR1=true&InvertRENInputR1=false&AlwaysAllowREX=true&RecycleDoorOpenTimeOnREX=false&EnableBeamFunctionOnZone4=false&InvertDoorStateControlR2=false&InvertSenseStateControlR2=false&InvertREXInputR2=true&InvertRENInputR2=false&AlwaysAllowREXR2=true&RecycleDoorOpenTimeOnREXR2=false&OfflineOperation=0&Reader1Elevator=2147483647&Reader2Elevator=2147483647&Reader1SecondaryFormat=0&Reader2SecondaryFormat=0&InvertFloorRelays=false&ControlRelaysOnCommFailure=false&RelaysActivatedInCommFailure=false&InvertFloorRelays1=false&ControlRelaysOnCommFailure1=false&RelaysActivatedInCommFailure1=false&SlaveCommOperation=0&ElevatorFloorSplit=0&Reader1FunctionPGM=2147483647&Reader2FunctionPGM=2147483647&ForcedDoorSendsDoorOpen1=false&DisableRedLEDProcessing1=false&DisableGreenLEDProcessing1=false&DisableBuzzerProcessing1=false&RecycleREXTime=false&ForcedDoorSendsDoorOpen2=false&DisableRedLEDProcessing2=false&DisableGreenLEDProcessing2=false&DisableBuzzerProcessing2=false&RecycleREXTime2=false&Reader1FunctionPGMGroup=2147483647&Reader2FunctionPGMGroup=2147483647&PhysicalAddress=0&Commands=&UseProgrammedCardExpiry=false&UseProgrammedCardExpiry2=false&NetworkTypePortOne=255&NetworkTypePortTwo=255&Reader1CardDataAESEncryptionKey=&Reader2CardDataAESEncryptionKey=&CardDataAESEncryptionKey=&Reader1DualAuthenticationPendingPGM=2147483647&Reader1DualAuthenticationWaitTime=10&EnableEnhancedSmartReaderOutputs=false&Reader2DualAuthenticationPendingPGM=2147483647&Reader2DualAuthenticationWaitTime=10&EnableEnhancedSmartReaderOutputs1=false&EthernetNetworkType=0&Reader1BaudRate=0&Reader1Parity=0&Reader1StopBits=0&Reader1InterByteTimeOut=65535&Reader1LogInvalidDataReceived=false&Reader2BaudRate=0&Reader2Parity=0&Reader2StopBits=0&Reader2InterByteTimeOut=65535&Reader2LogInvalidDataReceived=false

Update

Update a specific reader expander.

  • Request:

    Copy 
    http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_READEREXPANDERS_TBL&ReaderExpanderId=1&Name=RD1

  • Response:

    Copy 
    OK

Create

Create a reader expander. To create a reader expander, use the same parameters as update but leave the ReaderExpanderId empty.

  • Request:

    Copy 
    http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Submit&SubType=GXT_READEREXPANDERS_TBL&ReaderExpanderId=&Name=Onboard Reader&PollTime=250&ReaderOneFormat=32&ReaderTwoFormat=32&ReaderOneLocation=1&ReaderTwoLocation=1&ReaderOneMode=0&ReaderTwoMode=0&ReaderOneDoor=0&ReaderTwoDoor=1&ReaderOneKeypadType=2&ReaderTwoKeypadType=2&KeypadToUseForPINsReader1=2147483647&KeypadToUseForPINsReader2=2147483647&ReaderOneArmingMode=0&ReaderTwoArmingMode=0&AllowReadingOpenedUnlocked=true&InputFunctionsEnabled=true&LED1FollowsLock1PGM=false&BondSenseInputEnabled=false&REXEnabled=true&RENEnabled=false&SendFormatErrors=true&IntelligentReaderTamperMode=false&AllowReadingOpenedUnlocked1=true&InputFunctionsEnabled1=true&LED1FollowsLock1PGM1=false&BondSenseInputEnabled1=false&REXEnabled1=true&RENEnabled1=false&SendFormatErrors1=true&IntelligentReaderTamperMode1=false&DisarmAreaForDoorOnAccess=false&AllowAccessWhenAreaArmed=false&DisarmUsersAreaONValidCard=false&LogReaderEvents=false&SwapLockLEDDisplay=false&ActivateAccessLevelPGM=false&DisplayCardDetailWhenInvalid=true&ArmUsersArea=false&DisarmAreaForDoorOnAccess1=false&AllowAccessWhenAreaArmed1=false&DisarmUsersAreaONValidCard1=false&LogReaderEvents1=false&SwapLockLEDDisplay1=false&ActivateAccessLevelPGM1=false&DisplayCardDetailWhenInvalid1=true&ArmUsersArea1=false&HighChargeOption=false&MultipleReaderInputPort1=false&MultipleReaderInputPort2=false&VirtualModule=false&InvertDeviceTamper=false&EthernetSALLISEnabled=false&EthernetSALLISPort=1234&EthernetSALLISIp=192.168.0.234&Reader1AreaControlArea=2147483647&Reader2AreaControlArea=2147483647&EnableBeamFunctionOnZone3=false&InvertDoorStateControlR1=false&InvertSenseStateControlR1=false&InvertREXInputR1=true&InvertRENInputR1=false&AlwaysAllowREX=true&RecycleDoorOpenTimeOnREX=false&EnableBeamFunctionOnZone4=false&InvertDoorStateControlR2=false&InvertSenseStateControlR2=false&InvertREXInputR2=true&InvertRENInputR2=false&AlwaysAllowREXR2=true&RecycleDoorOpenTimeOnREXR2=false&OfflineOperation=0&Reader1Elevator=2147483647&Reader2Elevator=2147483647&Reader1SecondaryFormat=0&Reader2SecondaryFormat=0&InvertFloorRelays=false&ControlRelaysOnCommFailure=false&RelaysActivatedInCommFailure=false&InvertFloorRelays1=false&ControlRelaysOnCommFailure1=false&RelaysActivatedInCommFailure1=false&SlaveCommOperation=0&ElevatorFloorSplit=0&Reader1FunctionPGM=2147483647&Reader2FunctionPGM=2147483647&ForcedDoorSendsDoorOpen1=false&DisableRedLEDProcessing1=false&DisableGreenLEDProcessing1=false&DisableBuzzerProcessing1=false&RecycleREXTime=false&ForcedDoorSendsDoorOpen2=false&DisableRedLEDProcessing2=false&DisableGreenLEDProcessing2=false&DisableBuzzerProcessing2=false&RecycleREXTime2=false&Reader1FunctionPGMGroup=2147483647&Reader2FunctionPGMGroup=2147483647&PhysicalAddress=0&Commands=&UseProgrammedCardExpiry=false&UseProgrammedCardExpiry2=false&NetworkTypePortOne=255&NetworkTypePortTwo=255&Reader1CardDataAESEncryptionKey=&Reader2CardDataAESEncryptionKey=&CardDataAESEncryptionKey=&Reader1DualAuthenticationPendingPGM=2147483647&Reader1DualAuthenticationWaitTime=10&EnableEnhancedSmartReaderOutputs=false&Reader2DualAuthenticationPendingPGM=2147483647&Reader2DualAuthenticationWaitTime=10&EnableEnhancedSmartReaderOutputs1=false&EthernetNetworkType=0&Reader1BaudRate=0&Reader1Parity=0&Reader1StopBits=0&Reader1InterByteTimeOut=65535&Reader1LogInvalidDataReceived=false&Reader2BaudRate=0&Reader2Parity=0&Reader2StopBits=0&Reader2InterByteTimeOut=65535&Reader2LogInvalidDataReceived=false

  • Response:

    Copy 
    OK

When using the API to directly add records, please ensure the number of records added does not exceed the license limit for this record type, as this will result in undefined behavior. The license limit can be determined using the LicenseLimit request (see System).

Delete

Delete a specific reader expander.

  • Request:

    Copy 
    http://192.168.1.2/PRT_CTRL_DIN_ISAPI.dll?Command&Type=Delete&SubType=GXT_READEREXPANDERS_TBL&RecId=<RecId>

  • Response:

    Copy 
    OK

Parameters

Parameter

Display Name

Default Value

Notes

ReaderExpanderId

Database ID

0

The Detail, Control and Delete APIs use this value as the RecId.

Name

Name

Onboard Reader

 

PollTime

 

250

This is a legacy option that has no effect.

ReaderOneFormat

Reader 1 Format

32

See Reader Formats for the available settings.

ReaderTwoFormat

Reader 2 Format

32

See Reader Formats for the available settings.

ReaderOneLocation

Reader 1 Location

1

The settings are:

Value

Setting

0

Exit

1

Entry

ReaderTwoLocation

Reader 2 Location

1

The settings are:

Value

Setting

0

Exit

1

Entry

ReaderOneMode

Reader 1 Mode

0

The settings are:

Value

Setting

0

Access

1

Elevator

2

Area Control

ReaderTwoMode

Reader 2 Mode

0

The settings are:

Value

Setting

0

Access

1

Elevator

2

Area Control

ReaderOneDoor

Reader 1 Door

0

 

ReaderTwoDoor

Reader 2 Door

1

 

ReaderOneKeypadType

Reader 1 Keypad Type

2

The settings are:

Value

Setting

0

LCD Keypad

1

26 Bit (Site 0)

2

ARK-501

3

4 Bit

4

4 Bit Parity

5

4 Bit Buf

6

4 Bit Buf and Par

7

36 Bit IEI (Site 0)

8-14

Reserved

2147483647

None

ReaderTwoKeypadType

Reader 2 Keypad Type

2

The settings are:

Value

Setting

0

LCD Keypad

1

26 Bit (Site 0)

2

ARK-501

3

4 Bit

4

4 Bit Parity

5

4 Bit Buf

6

4 Bit Buf and Par

7

36 Bit IEI (Site 0)

8-14

Reserved

2147483647

None

KeypadToUseForPINsReader1

Keypad To Use For PINs Reader 1

2147483647

The settings are:

Value

Setting

0

LCD Keypad

1

26 Bit (Site 0)

2

ARK-501

3

4 Bit

4

4 Bit Parity

5

4 Bit Buf

6

4 Bit Buf and Par

7

36 Bit IEI (Site 0)

8-14

Reserved

2147483647

None

KeypadToUseForPINsReader2

Keypad To Use For PINs Reader 2

2147483647

The settings are:

Value

Setting

0

LCD Keypad

1

26 Bit (Site 0)

2

ARK-501

3

4 Bit

4

4 Bit Parity

5

4 Bit Buf

6

4 Bit Buf and Par

7

36 Bit IEI (Site 0)

8-14

Reserved

2147483647

None

ReaderOneArmingMode

Reader 1 Arming Mode

0

The settings are:

Value

Setting

0

Arm Area On 2 Reads

1

Read And Zone 4 Of Expander

2

Arm Area On 3 Reads

3

Toggle Function Output On 3 Reads

4

Activate Function Output On 3 Reads

2147483647

None

ReaderTwoArmingMode

Reader 2 Arming Mode

0

The settings are:

Value

Setting

0

Arm Area On 2 Reads

1

Read And Zone 4 Of Expander

2

Arm Area On 3 Reads

3

Toggle Function Output On 3 Reads

4

Activate Function Output On 3 Reads

2147483647

None

AllowReadingOpenedUnlocked

Allow Reading Opened/Unlocked (Reader 1)

true

 

InputFunctionsEnabled

Door Sense Enabled (Reader 1)

true

 

LED1FollowsLock1PGM

 

false

This is a legacy option that has no effect.

BondSenseInputEnabled

Bond Sense Input Enabled (Reader 1)

false

 

REXEnabled

REX Enabled (Reader 1)

true

 

RENEnabled

REN Enabled (Reader 1)

false

 

SendFormatErrors

Send Format Errors (Reader 1)

true

 

IntelligentReaderTamperMode

Intelligent Reader Tamper Mode (Reader 1)

false

 

AllowReadingOpenedUnlocked1

Allow Reading Opened/Unlocked (Reader 2)

true

InputFunctionsEnabled1

Door Sense Enabled (Reader 2)

true

 

LED1FollowsLock1PGM1

 

false

This is a legacy option that has no effect.

BondSenseInputEnabled1

Bond Sense Input Enabled (Reader 2)

false

 

REXEnabled1

REX Enabled (Reader 2)

true

 

RENEnabled1

REN Enabled (Reader 2)

false

 

SendFormatErrors1

Send Format Errors (Reader 2)

true

 

IntelligentReaderTamperMode1

Intelligent Reader Tamper Mode (Reader 2)

false

 

DisarmAreaForDoorOnAccess

Disarm Area For Door On Access (Reader 1)

false

 

AllowAccessWhenAreaArmed

Allow Access When Area Armed (Reader 1)

false

 

DisarmUsersAreaONValidCard

Disarm Users Area On Valid Card (Reader 1)

false

 

LogReaderEvents

Log Reader Events (Reader 1)

false

 

SwapLockLEDDisplay

Swap Lock LED Display (Reader 1)

false

 

ActivateAccessLevelPGM

Activate Access Level Output (Reader 1)

false

 

DisplayCardDetailWhenInvalid

Display Card Detail When Invalid (Reader 1)

true

 

ArmUsersArea

Arm Users Area (Reader 1)

false

 

DisarmAreaForDoorOnAccess1

Disarm Area For Door On Access (Reader 2)

false

 

AllowAccessWhenAreaArmed1

Allow Access When Area Armed (Reader 2)

false

 

DisarmUsersAreaONValidCard1

Disarm Users Area On Valid Card (Reader 2)

false

 

LogReaderEvents1

Log Reader Events (Reader 2)

false

 

SwapLockLEDDisplay1

Swap Lock LED Display (Reader 2)

false

 

ActivateAccessLevelPGM1

Activate Access Level Output (Reader 2)

false

 

DisplayCardDetailWhenInvalid1

Display Card Detail When Invalid (Reader 2)

true

 

ArmUsersArea1

Arm Users Area (Reader 2)

false

 

HighChargeOption

High Charge Option

false

This is a legacy option that has no effect.

MultipleReaderInputPort1

Multiple Reader Input Port 1

false

 

MultipleReaderInputPort2

Multiple Reader Input Port 2

false

 

VirtualModule

Virtual Module

false

 

InvertDeviceTamper

Invert Device Tamper

false

 

EthernetSALLISEnabled

 

false

This is a legacy option that has no effect.

EthernetSALLISPort

Ethernet Port

1234

 

EthernetSALLISIp

SALLIS Router IP

192.168.0.234

 

Reader1AreaControlArea

Reader 1 Area Control Area

2147483647

 

Reader2AreaControlArea

Reader 2 Area Control Area

2147483647

 

EnableBeamFunctionOnZone3

Enable Beam Function on Input 3

false

 

InvertDoorStateControlR1

Invert Door State Control R1

false

 

InvertSenseStateControlR1

Invert Sense State Control R1

false

 

InvertREXInputR1

Invert REX Input R1

true

 

InvertRENInputR1

Invert REN Input R1

false

 

AlwaysAllowREX

Always Allow REX R1

true

 

RecycleDoorOpenTimeOnREX

Recycle Door Open Time On REX R1

false

 

EnableBeamFunctionOnZone4

Enable Beam Function on Input 7

false

 

InvertDoorStateControlR2

Invert Door State Control R2

false

 

InvertSenseStateControlR2

Invert Sense State Control R2

false

 

InvertREXInputR2

Invert REX Input R2

true

 

InvertRENInputR2

Invert REN Input R2

false

 

AlwaysAllowREXR2

Always Allow REX R2

true

 

RecycleDoorOpenTimeOnREXR2

Recycle Door Open Time On REX R2

false

 

OfflineOperation

Offline Operation

0

The settings are:

Value

Setting

0

No Users

64

Any Card

128

First 10 Users Plus Cache

Reader1Elevator

Reader 1 Elevator

2147483647

 

Reader2Elevator

Reader 2 Elevator

2147483647

 

Reader1SecondaryFormat

Reader 1 Secondary Format

0

See Reader Formats for the available settings.

Reader2SecondaryFormat

Reader 2 Secondary Format

0

See Reader Formats for the available settings.

InvertFloorRelays

Invert Floor Relays (Reader 1)

false

This is a legacy option that has no effect.

ControlRelaysOnCommFailure

Control Relays On Comm Failure (Reader 1)

false

This is a legacy option that has no effect.

RelaysActivatedInCommFailure

Relays Activated In Comm Failure (Reader 1)

false

This is a legacy option that has no effect.

InvertFloorRelays1

Invert Floor Relays (Reader 2)

false

This is a legacy option that has no effect.

ControlRelaysOnCommFailure1

Control Relays On Comm Failure (Reader 2)

false

This is a legacy option that has no effect.

RelaysActivatedInCommFailure1

Relays Activated In Comm Failure (Reader 2)

false

This is a legacy option that has no effect.

SlaveCommOperation

Slave Comm Operation

0

This is a legacy option that has no effect.

ElevatorFloorSplit

Elevator Floor Split

0

This is a legacy option that has no effect.

Reader1FunctionPGM

Reader 1 Function Output

2147483647

 

Reader2FunctionPGM

Reader 2 Function Output

2147483647

 

ForcedDoorSendsDoorOpen1

Forced Door Sends Door Open (1)

false

 

DisableRedLEDProcessing1

Disable Red LED Processing 1

false

 

DisableGreenLEDProcessing1

Disable Green LED Processing 1

false

 

DisableBuzzerProcessing1

Disable Buzzer Processing 1

false

 

RecycleREXTime

Recycle REX Time 1

false

 

ForcedDoorSendsDoorOpen2

Forced Door Sends Door Open (2)

false

 

DisableRedLEDProcessing2

Disable Red LED Processing 2

false

 

DisableGreenLEDProcessing2

Disable Green LED Processing 2

false

 

DisableBuzzerProcessing2

Disable Buzzer Processing 2

false

 

RecycleREXTime2

Recycle REX Time 1

false

 

Reader1FunctionPGMGroup

Reader 1 Function Output Group

2147483647

 

Reader2FunctionPGMGroup

Reader 2 Function Output Group

2147483647

 

PhysicalAddress

Physical Address

0

 

Commands

Commands

 

 

UseProgrammedCardExpiry

Use Programmed Card Expiry (Reader 1)

false

 

UseProgrammedCardExpiry2

Use Programmed Card Expiry (Reader 2)

false

 

NetworkTypePortOne

Port 1 Network Type

255

The settings are:

Value

Setting

0

ICT RS485

1

OSDP

2

Aperio

3

Salto SALLIS

5

Allegion

7

Third Party Generic

255

Wiegand

When the network type is set to OSDP, two smart reader records will be created automatically.

NetworkTypePortTwo

Port 2 Network Type

255

The settings are:

Value

Setting

0

ICT RS485

1

OSDP

2

Aperio

3

Salto SALLIS

5

Allegion

7

Third Party Generic

255

Wiegand

When the network type is set to OSDP, two smart reader records will be created automatically.

Reader1CardDataAESEncryptionKey

Card Data AES Encryption Key (Reader 1)

 

 

Reader2CardDataAESEncryptionKey

Card Data AES Encryption Key (Reader 2)

 

 

CardDataAESEncryptionKey

Card Data AES Encryption Key

 

 

Reader1DualAuthenticationPendingPGM

Reader 1 Dual Authentication Pending Output (Reader 1)

2147483647

 

Reader1DualAuthenticationWaitTime

Reader 1 Dual Authentication Wait Time (Reader 1)

10

 

EnableEnhancedSmartReaderOutputs

Enable Enhanced Smart Reader Outputs (Reader 1)

false

 

Reader2DualAuthenticationPendingPGM

Reader 1 Dual Authentication Pending Output (Reader 2)

2147483647

 

Reader2DualAuthenticationWaitTime

Reader 1 Dual Authentication Wait Time (Reader 2)

10

 

EnableEnhancedSmartReaderOutputs1

Enable Enhanced Smart Reader Outputs (Reader 2)

false

 

EthernetNetworkType

Ethernet Network Type

0

The settings are:

Value

Setting

0

Disabled

1

SALLIS

2

Third Party Generic

Reader1BaudRate

Reader 1 Baud Rate

0

 

Reader1Parity

Reader 1 Parity

0

 

Reader1StopBits

Reader 1 Stop Bits

0

 

Reader1InterByteTimeOut

Reader 1 Inter-Byte Time Out

65535

 

Reader1LogInvalidDataReceived

Reader 1 Log Invalid Data Received

false

 

Reader2BaudRate

Reader 2 Baud Rate

0

 

Reader2Parity

Reader 2 Parity

0

 

Reader2StopBits

Reader 2 Stop Bits

0

 

Reader2InterByteTimeOut

Reader 2 Inter-Byte Time Out

65535

 

Reader2LogInvalidDataReceived

Reader 2 Log Invalid Data Received

false